/**
 * The New BSD license is used for the ForD2 RPG (Multi-Layered Framework for
 * Authoring Dungeons and Dragons Based Role Playing Games).
 * Components to provide the largest
 * amount of freedom for developers that want to base their application on this
 * product.
 *
 * Copyright (c) 2007, ForD2 RPG Systems A.S.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * - Neither the name of ForD2 RPG Systems A.S. nor the names of its
 *   contributors may be used to endorse or promote products derived from this
 *   software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

package framework.core.character;

import framework.persistence.GenericPersistentable;
import java.util.ArrayList;
import java.util.List;

/**
 * This class represents one character ability.
 * @author <B>Marcos Tadeu Silva</B>
 *         e-mail: <I>zero.ufal@gmail.com</I>, 08/31/2007.
 * @version 0.1
 * @since first
 */
public class Ability extends GenericPersistentable {
    
    // constants ------------------------------------------------------------
    
    // properties -----------------------------------------------------------
    
    /**
     * Ability Name. Ex.: Dexterity
     */
    public String name;
    /**
     * Ability ShortName. Used to contracts the name. Ex.: Dexterity - Dex.
     */
    public String shortName;
    /**
     * A description about the ability. Ex.: This ability make your character
     * faster against fire balls..
     */
    public String description;
    
    /**
     * The points of the ability. Its value. Ex.: 12
     */
    private int value;
    
    /**
     * Ability referencied Modifiers. Ex.: Dex 12 modifiers 1. Its values
     * was determine using modifiers rules.
     */
    private List<Modifier> modifiers;
    
    // static  --------------------------------------------------------------
    
    // constructors ---------------------------------------------------------
    
    /**
     * Creates a new Instance of Ability initializating the modifiers List.
     */
    public Ability() {
        value = 0;
        modifiers = new ArrayList<Modifier>();
    }
    
    /**
     * Creates a new Instance of Ability. It Calls the firts Constructor
     * to initializes dependent atributes.
     * @param name the name of the ability.
     * @param shortName a shortName of the ability.
     * @param description a description about the ability.
     */
    public Ability(final String name, final String shortName,
            final String description) {
        this();
        this.name = name;
        this.shortName = shortName;
        this.description = description;
    }
    
    // private methods ------------------------------------------------------
    
    // public methods -------------------------------------------------------
    
    /**
     * Add a new modifier verifying if the parameter object is null and if it
     * doens't exists.
     * @param toAdd the Modifier object to be added.
     */
    public void addModifier(final Modifier toAdd) {
        if (toAdd == null) {
            throw new NullPointerException("Object cannot be NULL");
        }
        
        if (modifiers.contains(toAdd)) {
            throw new IllegalArgumentException("Modifier Already exists.");
        }
        
        modifiers.add(toAdd);
    }
    
    /**
     * Gets the modifiers of the Ability.
     * @return an List of the modifiers of the Ability.
     */
    public List<Modifier> getModifiers() {
        return modifiers;
    }
    
    /**
     * Removes a new modifier verifying if the parameter object is null and if it
     * exists.
     * @param toRemove the Modifier object to be removed.
     */    
    public void removeModifier(final Modifier toRemove) {
        if (toRemove == null) {
            throw new NullPointerException("Object cannot be NULL");
        }
        
        if (!modifiers.contains(toRemove)) {
            throw new IllegalArgumentException("Modifier doesn't exists.");
        }
        
        modifiers.remove(toRemove);
    }
    
    /**
     * Gets the value of the Ability.
     * @return the value of the Ability (Ex.: 12, 13, 15).
     */
    public int getValue() {
        return value;
    }
    
    /**
     * Sets the Ability modifiers List.
     * @param modifiers the modifiers attribute
     */
    public void setModifiers(final List<Modifier> modifiers) {
        this.modifiers = modifiers;
    }
    
    /**
     * Sets the value of the Ability. That method is always validated against
     * invalid values. The author determine the valid values so the default instance
     * will validate with positive values.
     * @param value the atribute value
     */
    public void setValue(final int value) {
        this.value = value;
    }
    
    // x override -----------------------------------------------------------
    
    // y implementation -----------------------------------------------------
    
    // z inner class --------------------------------------------------------
    
}

